﻿shantay                package:nenhum                R Documentation


Sorteio de unidades amostrais com base em criterios fornecidos pelo
usuario e da distancia minima necessaria entre elas.


Description:

A partir de um dataframe, sorteia um determinado numero de unidades
amostrais com base nos criterios ano de nascimento maximo, sexo, area
de estudo e distancia minima entre suas localizacoes. Salva essas
informacoes em um arquivo .txt separado por tabulacao e retorna um plano 
cartesiano com as unidades amostrais sorteadas em uma nova janela grafica.


Usage:

shantay(dados, n.amostra, ano.nasc, sexo, area.estudo, dist.min)



Arguments:

dados:		Dataframe; deve conter na primeira coluna o ID da unidade 
		amostral; na segunda coluna, o sexo; na terceira coluna, 
		o ano de nascimento da unidade amostral (para critério de
		idade);	na quarta coluna, a área de estudo na qual a pessoa
		reside; na quinta coluna, o ID da localizacao da unidade
		amostral, na sexta e sétima colunas, a latitude e a longitude
		da localizacao de cada unidade amostral, respectivamente.

n.amostra:	Valor numerico; numero de unidades amostrais a serem 
		sortadas.

ano.nasc:	Valor numerico: ano de nascimento maximo de interesse
		(para criterio de idade minima). Nota: se idade das
		unidades amostrais estiver em anos, pode-se calcular
		seu ano de nascimento subtraindo-se a idade de em anos
		de cada unidade amostral do ano calendario atual.

sexo:		Caracter; sexo das unidades amostrais de interesse. Recebe:
		'f' (feminino), 'm' (masculino) ou 'na' se o sexo nao importar
		como criterio de selecao.

area.estudo:	Caracter; recebe o nome da area de estudo de interesse.

dist.min:	Valor numerico; distancia (em metros) minima a que cada
		unidade amostral deve estar uma da outra.


Details:

E necessario ter o pacote 'sp' instalado.

A latitude e a longitude devem estar informadas em graus decimais e, no
dataframe de input, localizadas nas sexta e setima colunas, respectivamente.

Todos os argumentos da funcao devem ser fornecidos.


Value:

A funcao shantay retorna:
	
	No console, o numero de unidades amostrais que foram removidos
	a cada criterio de selecao fornecido e um dataframe que contenha
	as unidades amostrais selecionadas com suas respectivas
	características (sexo, ano de nascimento, área de estudo,
	localizacao, latitude e longitude de cada unidade amostral.

	Tambem retorna um arquivo .txt separado por tabulacao deste dataframe,
	salvo no diretorio de trabalho corrente do R sob o nome 'amostragem.txt'.

	Uma nova janela grafica com uma imagem com as unidades amostrais
	selecionadas plotadas em um plano cartesiano.


Warnings:

A funcao e interrompida e retornam-se mensagens de erro quando o objeto de
entrada nao e um dataframe, quando algum dos argumentos nao e fornecido, o
pacote 'sp' nao esta instalado e quando o numero de unidades amostrais
disponiveis para sorteio apos os criterios de selecao e menor do que o numero
de unidades amostrais a serem sorteadas. 

Na primeira vez que a funcao e executada, exibe uma mensagem de aviso que o
pacote 'sp' foi carregado SE ele estiver instalado.

Notes:

Atencao para nao sobrescrever o arquivo .txt. Se ele for interessante, convem-se
renomea-lo antes de executar a funcao novamente. 


Author(s):

Lucas Teixeira
lteixeira@ib.usp.br

Sao Paulo, 7 de maio de 2016

Especiais agradecimentos a Gabriela Marin e Vinicius Biffi,
pela disponibilidade em me explicar alguns comandos e argumentos.


References:

Newing, H., Eagle, C., Puri, R. & Watson, C.W. 2011. Conducting research in 
conservation: a social science perspective, Routledge, New York.

Pacote 'sp': https://cran.r-project.org/web/packages/sp/sp.pdf


See Also:

Funcoes: subset(), spDists(), sample(), plot()


Examples:

dados <- read.table("exemplo_help.txt", header=TRUE, dec=".", sep="\t",
	 as.is = TRUE)

shantay(dados, 8, 1997, sexo="f", "area1", 800)
shantay(dados, 10, 1995, sexo="NA", "area1", 500)